Configuring Endpoint More Settings

Procedure

1. On the Get Started page, click API Definitions.

   Or

   Navigate to Design > APIs. This opens the Manage your APIs with API Definitions page.

2. In the Name column, click the API definition link or Settings icon next to the row that you want to configure endpoint settings. This opens the Endpoints:<your api name> page.

3. On the Endpoints:<your api name> page, in the Name column, click the specific endpoint link or Settings icon next to the row you want to configure endpoint settings. This opens the Methods: <your api name> page.

4. Navigate to More Settings. This opens the Endpoints More Settings:<your endpoint name> page.

   1. In Time to wait for a response from endpoint, enter a timeout value between 2 and 1200 seconds.

      important

      A timeout value less than or equal to 60 seconds can be set directly in the Boomi Cloud API Management. Any value greater than 60 seconds requires assistance from Boomi via a support case.

      If you have entered a timeout value greater than 60 seconds and have not requested the timeout to be extended via Boomi Support, then you will receive a 504 gateway timeout error. This limitation is only applicable to Boomi Cloud API Management and does not apply to Boomi Cloud API Management - Local Edition.

      2. In Seconds to attempt initial connection to endpoint, enter the time in seconds for which an attempt of initial connection to the endpoint can be made.

      3. In Number of HTTP Redirects to follow (as needed), enter the number of HTTP redirects to follow. By default, Cloud API Management does not handle any redirects.

      4. Click the Enable Cookies during redirects toggle switch to enable cookies.

      5. Click the GZIP Passthrough toggle switch to enable gzip passthrough.

      6. Click the Force GZip Accept-encoding on backend call toggle switch to enable the gzip directive on the backend server.

      7. Click the Remove API Key and Signature from Endpoint Call toggle switch to enable it. This will remove the API key and signature from API calls made to the client server.

         note

         This configuration is not applicable to the API key sent in the request body.

      8. Click the Allow calls having no API Key toggle switch to enable it for allowing API calls without an API key.

      9. Click the Swap Incoming API credentials for API Management Credentials toggle switch to enable it for swapping incoming API credentials for API Management credentials before passing the API calls to the client API server.

      10. In Forwarded Headers, select API Management Service ID, API Management Host, or API Management Message ID header value to add headers in your API request. These will not be in the response.

      11. In Returned Headers, select API Management Responder or API Management Message ID header values to add headers in your API response.

      12. Click the Pass Through Host Header in Request toggle switch to enable it, to pass through a host header in the request instead of target hostname.

      13. In HTTP Headers to Drop from Incoming Call: (one per line), enter the HTTP headers that you want to remove from an API call.

      14. In JSONP Callback Function Parameter, enter a JSON callback function parameter to handle the JSON response.

      15. In Default JSONP Callback Function Parameter Value, enter the default callback function parameter value. By default, this field is empty.

      16. Click the Include rate limit information in response headers toggle switch to enable it, to include developer key limits in the response headers.